Operation Relations.GetRelations (Get Linked Documents)

In component org.nuxeo.ecm.core.automation.featuresContrib

Description

Get the relations for the input document. The 'outgoing' parameter ca be used to specify whether outgoing or incoming relations should be returned. Retuns a document list.

Operation id	Relations.GetRelations
Category	Services
Label	Get Linked Documents
Requires
Since

Parameters

Name	Type	Required
predicate	string	yes
graphName	string	no
outgoing	boolean	no

Signature

Inputs	document
Outputs	documents

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.automation.core.operations.services.GetRelations
Contributing Component	org.nuxeo.ecm.core.automation.featuresContrib

JSON Definition

{
  "id" : "Relations.GetRelations",
  "label" : "Get Linked Documents",
  "category" : "Services",
  "requires" : null,
  "description" : "Get the relations for the input document. The 'outgoing' parameter ca be used to specify whether outgoing or incoming relations should be returned. Retuns a document list.",
  "url" : "Relations.GetRelations",
  "signature" : [ "document", "documents" ],
  "params" : [ {
    "name" : "predicate",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "graphName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "outgoing",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}